Skip to main content

Create new business account

POST /api/v1/Businesses/create

Description​

This endpoint allows you to create a new business account.

Request​

  • Path: /api/v{version}/Businesses/create

  • Headers:

    • Accept-Language: Change default response message language from English(en). Available languages fr,en

  • Request Body: CreateBusinessRequest

  • Response: CreateBusinessResponse

Response Examples:

  1. Success:
{
  "id": "123",
  "name": "Sample Business",
  "email": "business@example.com",
  "phone": "123456789",
  "address": "123 Example St., Exampleville, EX, 12345"
}

/api/v1/Businesses/create

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "name": <string>,
  "incorporationDate": <dateTime>,
  "industry": <string>,
  "mobileNumber": <string>,
  "countryOfIncorporation": <string>,
  "incorporationType": <string>,
  "incorporationNumber": <string>,
  "websiteUrl": <string>,
  "termsAndConditionsSignedAt": <dateTime>,
  "address": {
    "addressLine1": <string>,
    "addressLine2": <string>,
    "state": <string>,
    "city": <string>,
    "zipCode": <string>
  },
  "businessDetails": {
    "email": <string>,
    "country": <string>,
    "registeredBusinessAddress": <string>,
    "operatingAddress": <string>,
    "taxIdentificationNumber": <string>,
    "natureofBusiness":<string>,
    "staffInfo": <string>,
    "shopName": <string>,
    "lga": <string>,
    "state": <string>,
    "bankName": <string>,
    "bankAccountNumber": <string>,
    "bankAccountName": <string>,
    "dateFormat": <string>,
    "locale": <string>
  },
  "director1": {
    "firstName": <string>,
    "middleName": <string>,
    "lastName": <string>,
    "dateofBirth": <dateTime>,
    "gender": <string>,
    "bvn": <string>,
    "nin": <string>,
    "emailAddress": <string>,
    "phoneNumber": <string>,
    "address": <string>
  },
  "director2": {
    "firstName": <string>,
    "middleName": <string>,
    "lastName": <string>,
    "dateofBirth": <dateTime>,
    "gender": <string>,
    "bvn": <string>,
    "nin": <string>,
    "emailAddress": <string>,
    "phoneNumber": <string>,
    "address": <string>
  },
  "companyRepresentative": {
    "firstName": <string>,
    "middleName": <string>,
    "lastName": <string>,
    "dateofBirth": <dateTime>,
    "gender": <string>,
    "bvn": <string>,
    "nin": <string>,
    "emailAddress": <string>,
    "phoneNumber": <string>,
    "address": <string>
  }
}

Response: 200​

{
  "succeeded": <boolean>,
  "message": <string>,
  "errors": [
    <string>,
    <string>
  ],
  "data": {
    "address": {
      "addressLine1": <string>,
      "addressLine2": <string>,
      "state": <string>,
      "city": <string>,
      "zipCode": <string>
    },
    "id": <uuid>,
    "userId": <uuid>,
    "tenantId": <uuid>,
    "name": <string>,
    "incorporationDate": <dateTime>,
    "industry": <string>,
    "mobileNumber": <string>,
    "countryOfIncorporation": <string>,
    "incorporationType": <string>,
    "incorporationNumber": <string>,
    "websiteUrl": <string>,
    "termsAndConditionsSignedAt": <dateTime>,
    "clientId": <integer>
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/Businesses/create \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!